home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Interfaces / CIncludes / OpenTptInternet.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-02-13  |  10.1 KB  |  378 lines  |  [TEXT/MPS ]
  1. /*
  2.     File:        OpenTptInternet.h
  3.  
  4.     Contains:    Client TCP/IP definitions
  5.  
  6.     Copyright:    © 1993-1995 by Apple Computer, Inc., all rights reserved.
  7.  
  8.  
  9. */
  10.  
  11.  
  12. #ifndef __OPENTPTINTERNET__
  13. #define __OPENTPTINTERNET__
  14.  
  15. #ifndef REZ
  16.     #ifndef __OPENTRANSPORT__
  17.     #include <OpenTransport.h>
  18.     #endif    
  19.     #if PRAGMA_ALIGN_SUPPORTED
  20.     #pragma options align=mac68k
  21.     #endif
  22.  
  23. /*******************************************************************************
  24. ** Misc 
  25. ********************************************************************************/
  26.  
  27. typedef UInt16    InetPort;
  28. typedef UInt32    InetHost;
  29.  
  30. //
  31. //    Enums used as address type designations.
  32. //
  33. enum
  34. {
  35.     AF_INET                = 2,    // Traditonal
  36.     AF_DNS                = 42    // Obviously, the answer to...
  37. };
  38.  
  39. //
  40. //    Enum which can be used to bind to all IP interfaces
  41. //    rather than a specific one.
  42. //
  43. enum
  44. {
  45.     kOTAnyInetAddress    = 0        // Wildcard
  46. };
  47.  
  48. #ifdef __cplusplus
  49.     class    TInternetServices;
  50.     typedef TInternetServices*    InetSvcRef;
  51. #else
  52.     typedef void*    InetSvcRef;
  53. #endif
  54.  
  55.  
  56. #endif    /*    REZ    */
  57.  
  58. /*******************************************************************************
  59. ** Some prefixes for shared libraries
  60. ********************************************************************************/
  61.  
  62. #define kInetVersion    "3.0"                /* MacTCP 3.0 */
  63. #define kInetPrefix        "ot:inet$"
  64.  
  65. /*******************************************************************************
  66. ** Module Names
  67. ********************************************************************************/
  68. #define kDNRName        "dnr"
  69. #define kTCPName        "tcp"
  70. #define kUDPName        "udp"
  71. #define kRawIPName        "rawip"
  72.  
  73. /*******************************************************************************
  74. ** XTI Options
  75. ********************************************************************************/
  76.  
  77. // Protocol levels
  78.  
  79. #define    INET_IP         0x0
  80. #define    INET_TCP     0x06
  81. #define    INET_UDP     0x11
  82.  
  83.  
  84. // TCP Level Options
  85.  
  86. #define    TCP_NODELAY                     0x01
  87. #define    TCP_MAXSEG                     0x02
  88. #define TCP_NOTIFY_THRESHOLD        0x10    /** not a real XTI option */
  89. #define TCP_ABORT_THRESHOLD            0x11    /** not a real XTI option */
  90. #define TCP_CONN_NOTIFY_THRESHOLD    0x12    /** not a real XTI option */
  91. #define TCP_CONN_ABORT_THRESHOLD    0x13    /** not a real XTI option */
  92. #define TCP_OOBINLINE                0x14    /** not a real XTI option */
  93. #define TCP_URGENT_PTR_TYPE            0x15    /** not a real XTI option */
  94. #define    TCP_KEEPALIVE                 OPT_KEEPALIVE    /* keepalive defined in OpenTransport.h */
  95.  
  96. #define    T_GARBAGE                     2            
  97.  
  98.  
  99. // UDP Level Options
  100.  
  101. #define    UDP_CHECKSUM        OPT_CHECKSUM
  102. #define UDP_RX_ICMP            0x2
  103.  
  104. // IP Level Options
  105.  
  106. #define    IP_OPTIONS             0x01
  107. #define    IP_TOS                 0x02
  108. #define    IP_TTL                 0x03
  109. #define    IP_REUSEADDR         0x04
  110. #define    IP_DONTROUTE         0x10
  111. #define    IP_BROADCAST         0x20
  112. #define    IP_HDRINCL             0x1002    
  113. #define IP_RCVOPTS             0x1005
  114. #define IP_RCVDSTADDR         0x1007
  115. #define    IP_MULTICAST_IF         0x1010        /* set/get IP multicast interface    */
  116. #define    IP_MULTICAST_TTL     0x1011        /* set/get IP multicast timetolive    */
  117. #define    IP_MULTICAST_LOOP     0x1012        /* set/get IP multicast loopback    */
  118. #define    IP_ADD_MEMBERSHIP     0x1013        /* add an IP group membership        */
  119. #define    IP_DROP_MEMBERSHIP     0x1014        /* drop an IP group membership        */
  120. #define    IP_BROADCAST_IF         0x1015        /* Set interface for broadcasts     */
  121. #define    IP_RCVIFADDR         0x1016        /* Set interface for broadcasts     */
  122.  
  123. //    DVMRP-specific setsockopt commands, from ip_mroute.h
  124. //
  125. #define    DVMRP_INIT        100
  126. #define    DVMRP_DONE        101
  127. #define    DVMRP_ADD_VIF    102
  128. #define    DVMRP_DEL_VIF    103
  129. #define    DVMRP_ADD_LGRP    104
  130. #define    DVMRP_DEL_LGRP    105
  131. #define    DVMRP_ADD_MRT    106
  132. #define    DVMRP_DEL_MRT    107
  133.  
  134.  
  135. #ifndef REZ
  136.  
  137. // IP_TOS precdence levels
  138. enum
  139. {
  140.     T_ROUTINE        = 0,
  141.     T_PRIORITY        = 1,
  142.     T_IMMEDIATE        = 2,
  143.     T_FLASH            = 3,
  144.     T_OVERRIDEFLASH    = 4,
  145.     T_CRITIC_ECP    = 5,
  146.     T_INETCONTROL    = 6,
  147.     T_NETCONTROL    = 7
  148. };
  149.  
  150. //    IP_TOS type of service
  151. enum
  152. {
  153.     T_NOTOS        = 0x0,        
  154.     T_LDELAY    = (1<<4),
  155.     T_HITHRPT    = (1<<3),
  156.     T_HIREL     = (1<<2)
  157. };
  158.  
  159. #define    SET_TOS(prec,tos)    (((0x7 & (prec)) << 5) | (0x1c & (tos)))
  160.  
  161. // IP Multicast option structures
  162. struct TIPAddMulticast
  163. {
  164.     InetHost multicastGroupAddress;
  165.     InetHost interfaceAddress;
  166. };
  167. typedef struct TIPAddMulticast TIPAddMulticast;
  168.  
  169.  
  170. /*******************************************************************************
  171. ** Protocol-specific events
  172. ********************************************************************************/
  173.  
  174. enum
  175. {
  176.     T_DNRSTRINGTOADDRCOMPLETE    = kPRIVATEEVENT+1,
  177.     T_DNRADDRTONAMECOMPLETE        = kPRIVATEEVENT+2,
  178.     T_DNRSYSINFOCOMPLETE        = kPRIVATEEVENT+3,
  179.     T_DNRMAILEXCHANGECOMPLETE    = kPRIVATEEVENT+4,
  180.     T_DNRQUERYCOMPLETE            = kPRIVATEEVENT+5
  181. };
  182.  
  183. /*******************************************************************************
  184. ** InetAddress
  185. ********************************************************************************/
  186.  
  187. struct InetAddress
  188. {
  189.         OTAddressType    fAddressType;    // always AF_INET
  190.         InetPort        fPort;            // Port number 
  191.         InetHost        fHost;            // Host address in net byte order
  192.         UInt8            fUnused[8];        // Traditional unused bytes
  193. };
  194. typedef struct InetAddress InetAddress;
  195.  
  196. /*******************************************************************************
  197. ** Domain Name Resolver (DNR) 
  198. ********************************************************************************/
  199.  
  200. enum 
  201. { 
  202.         kMaxHostAddrs         =  10,
  203.         kMaxSysStringLen     =  32,
  204.         kMaxHostNameLen        = 255
  205. };
  206.  
  207. typedef char InetDomainName[kMaxHostNameLen + 1];
  208.  
  209. struct InetHostInfo
  210. {
  211.     InetDomainName    name;
  212.     InetHost        addrs[kMaxHostAddrs];
  213. };
  214. typedef struct InetHostInfo    InetHostInfo;
  215.  
  216. struct InetSysInfo
  217. {
  218.     char        cpuType[kMaxSysStringLen];
  219.     char        osType[kMaxSysStringLen];
  220. };
  221. typedef struct InetSysInfo InetSysInfo;
  222.  
  223. struct InetMailExchange
  224. {
  225.     UInt16            preference;
  226.     InetDomainName    exchange;
  227. };
  228. typedef struct InetMailExchange InetMailExchange;
  229.  
  230. struct DNSQueryInfo
  231. {
  232.     UInt16            qType;
  233.     UInt16            qClass;
  234.     UInt32            ttl;
  235.     InetDomainName    name;
  236.     UInt16            responseType;        // answer, authority, or additional
  237.     UInt16            resourceLen;        // actual length of array which follows
  238.     char            resourceData[4];    // size varies
  239. };
  240. typedef struct DNSQueryInfo DNSQueryInfo;
  241.  
  242.  
  243. /*******************************************************************************
  244. ** DNSAddress
  245. **
  246. **        The DNSAddress format is optional and may be used in connects,
  247. **        datagram sends, and resolve address calls.   The name takes the 
  248. **        format "somewhere.com" or "somewhere.com:portnumber" where
  249. **        the ":portnumber" is optional.   The length of this structure
  250. **        is arbitrarily limited to the overall max length of a domain
  251. **        name (255 chars), although a longer one can be use successfully
  252. **        if you use this as a template for doing so.   However, the domain name 
  253. **        is still limited to 255 characters.
  254. ********************************************************************************/
  255.  
  256. struct DNSAddress
  257. {
  258.     OTAddressType    fAddressType;    // always AF_DNS
  259.     InetDomainName    fName;            
  260. };
  261. typedef struct DNSAddress DNSAddress;
  262.  
  263. /*******************************************************************************
  264. ** InetInterfaceInfo
  265. ********************************************************************************/
  266.  
  267. struct InetInterfaceInfo
  268. {
  269.     InetHost        fAddress;
  270.     InetHost        fNetmask;
  271.     InetHost        fBroadcastAddr;
  272.     InetHost        fDefaultGatewayAddr;
  273.     InetHost        fDNSAddr;
  274.     UInt16            fVersion;
  275.     UInt16            fHWAddrLen;
  276.     UInt8*            fHWAddr;
  277.     UInt32            fIfMTU;
  278.     UInt8*            fReservedPtrs[2];
  279.     InetDomainName    fDomainName;
  280.     UInt8            fReserved[256];            
  281. };
  282. typedef struct InetInterfaceInfo InetInterfaceInfo;
  283.  
  284.  
  285.  
  286. /*******************************************************************************
  287. ** Static helper functions
  288. ********************************************************************************/
  289.  
  290. #ifdef __cplusplus
  291. extern "C" {
  292. #endif
  293.  
  294. extern pascal void             OTInitInetAddress(InetAddress* addr, InetPort port, InetHost host);
  295. extern pascal size_t        OTInitDNSAddress(DNSAddress* addr, char* str);
  296. extern pascal OSStatus         OTInetStringToHost(char* str, InetHost* host);
  297. extern pascal void          OTInetHostToString(InetHost host, char* str);
  298. extern pascal OSStatus         OTInetGetInterfaceInfo(InetInterfaceInfo* info, SInt32 val);
  299.  
  300. #ifdef __cplusplus
  301. }
  302. #endif
  303.  
  304.  
  305. /*******************************************************************************
  306. ** InetServices & DNR calls
  307. ********************************************************************************/
  308.  
  309. #define kDefaultInternetServicesPath    ((OTConfiguration*)-3)
  310.  
  311. #if !OTKERNEL
  312.  
  313. #ifdef __cplusplus
  314. extern "C" {
  315. #endif
  316.  
  317. extern pascal InetSvcRef     OTOpenInternetServices(OTConfiguration* cfig, OTOpenFlags oflag, OSStatus* err);
  318. extern pascal OSStatus        OTAsyncOpenInternetServices(OTConfiguration* cfig, OTOpenFlags oflag, 
  319.                                                         OTNotifyProcPtr proc, void* contextPtr);
  320. extern pascal OSStatus         OTInetStringToAddress(InetSvcRef ref, char* name,
  321.                                                   InetHostInfo* hinfo);
  322. extern pascal OSStatus         OTInetAddressToName(InetSvcRef ref, InetHost addr, 
  323.                                                 InetDomainName name);
  324. extern pascal OSStatus         OTInetSysInfo(InetSvcRef ref, char* name,
  325.                                           InetSysInfo* sysinfo);
  326. extern pascal OSStatus         OTInetMailExchange(InetSvcRef ref, char* name, UInt16* num,
  327.                                                InetMailExchange* mx);
  328.                                                
  329. extern pascal OSStatus        OTInetQuery(InetSvcRef ref, char* name, UInt16 qClass, UInt16 qType,
  330.                                           char* buf, size_t buflen, 
  331.                                         void** argv, size_t argvlen,
  332.                                         OTFlags flags);
  333.                     
  334.  
  335. #ifdef __cplusplus
  336. }
  337. #endif
  338.  
  339. enum
  340. {
  341.     kDefaultInetInterface    = -1,
  342.     kInetInterfaceInfoVersion    = 2
  343. };
  344.  
  345. #ifdef __cplusplus
  346.  
  347. class TInternetServices : public TProvider
  348. {
  349.     public:
  350.             OSStatus     StringToAddress(char* name, InetHostInfo* hinfo)
  351.                         { return OTInetStringToAddress(this, name, hinfo); }
  352.                     
  353.             OSStatus     AddressToName(InetHost addr, InetDomainName name)
  354.                         { return OTInetAddressToName(this, addr, name); }
  355.                     
  356.             OSStatus     SysInfo(char* name, InetSysInfo* sysinfo )
  357.                         { return OTInetSysInfo(this, name, sysinfo); }
  358.                     
  359.             OSStatus     MailExchange(char* name, UInt16* num, InetMailExchange* mx)
  360.                         { return OTInetMailExchange(this, name, num, mx); }
  361.                         
  362.             OSStatus    Query(char* name, UInt16 qClass, UInt16 qType, 
  363.                               char* buf, size_t buflen, 
  364.                               void** argv, size_t argvlen,
  365.                               OTFlags flags)
  366.                         { return OTInetQuery(this, name, qClass, qType, buf, buflen, argv, argvlen, flags); }
  367. };
  368.  
  369. #endif
  370. #endif        /* !OTKERNEL */
  371.  
  372. #if PRAGMA_ALIGN_SUPPORTED
  373. #pragma options align=reset
  374. #endif
  375.  
  376. #endif    /*    REZ    */
  377. #endif        /* __OTINTERNET__ */
  378.